Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add documentation framework #23

Draft
wants to merge 23 commits into
base: main
Choose a base branch
from
Draft

Add documentation framework #23

wants to merge 23 commits into from

Conversation

kabilar
Copy link
Member

@kabilar kabilar commented Nov 21, 2024

  • Create documentation framework with Material for Mkdocs
  • Autogenerate API docs using mkdocstrings, mkdocs-gen-files, and mkdocs-literate-nav
  • Implement custom domain at convert.lincbrain.org
  • Update custom word list for spellcheck to ignore
  • Preview available at https://kabilar.github.io/linc-convert/

requirements.txt Outdated
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Do we want to rename this, so we know it is only for docs? Also, probably we can add this into pyproject.yaml as a dependency group.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Hi @calvinchai, I moved this file to within the docs/ directory. I am not sure how to get MkDocs to work with the pyproject.yaml file.

@kabilar kabilar changed the title Add documentation framework with Mkdocs Material Add documentation framework Nov 22, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants